Restore missing SDK client docs in API reference#434
Merged
Conversation
sunildkumar
approved these changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The API reference docs page (
/api-reference-docs/) was missing all content forGroundlightandExperimentalApi-- only the API response object models were rendering.Root cause: PR #413 ("Migrate Edge Configuration to SDK") introduced
groundlight/edge/config.py, which doesimport yaml. PR #419 ("SDK Configures Edge") then wired this into the import chain accessible fromgroundlight/__init__.py. When sphinx builds the docs, it installs only thesphinx-depsdependency group (viapoetry install --no-root --only sphinx-deps). Sincepyyamlwas not in that group, sphinx'sautodocfailed to importgroundlight.Groundlightandgroundlight.ExperimentalApiwithNo module named 'yaml'. Sphinx treated this as a non-fatal warning and silently omitted those sections from the built docs. The docs have been broken since the April 7 deploy.Changes
pyproject.toml: Removed duplicate dependencies fromsphinx-depsthat were already in the main deps group (pillow,pydantic,python-dateutil). Thesphinx-depsgroup now only contains sphinx-specific packages.Makefile: Changedinstall-sphinx-depsto install both themainandsphinx-depsgroups (--only main --only sphinx-deps), so sphinx always has access to whatever the SDK imports. Also added-WtoSPHINXOPTSso sphinx treats warnings as errors -- CI will now fail immediately if autodoc can't import a documented class, preventing this class of silent breakage in the future.sphinx_docs/conf.py: Removedhtml_static_pathentry referencing a non-existent_staticdirectory.sphinx_docs/models.rst: AddedEdgeEndpointApias a documented class under a new "Edge Endpoint API" section.src/groundlight/edge/api.py: ImprovedEdgeEndpointApiclass docstring to explain how it's accessed (gl.edge).src/groundlight/client.pyandsrc/groundlight/experimental_api.py: Fixed pre-existing RST docstring formatting issues (indentation errors, missing::on code block headers, trailing underscores interpreted as hyperlink references) that-Wsurfaced.